📖 docs: Update argocd-agent solution to use clusteradm#1348
Conversation
Signed-off-by: Mike Ng <ming@redhat.com>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mikeshng The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
WalkthroughUpdates documentation for the ArgoCD agent addon installation process. Replaces Helm CLI references with clusteradm CLI in prerequisites, installation commands, and validation procedures. Modifies namespace creation workflow and removes CreateNamespace syncOption from the Application configuration. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
/assign @xiangjingli |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@solutions/argocd-agent/README.md`:
- Line 90: The README currently shows an incorrect clusteradm command using the
addon name "argocd-agent" and an unsupported flag "--create-namespace"; update
the invocation of clusteradm (the line containing "clusteradm install
hub-addon") to use the correct addon name "argocd" and remove the unsupported
"--create-namespace" flag so the command becomes "clusteradm install hub-addon
--names argocd".
🧹 Nitpick comments (1)
solutions/argocd-agent/README.md (1)
170-177: Document the workflow change from auto-namespace creation to manual.The shift from using
syncOptions: CreateNamespace=true(auto-creation) to requiring manual namespace creation on the managed cluster is a significant workflow change. Consider:
- Adding an explanation of why manual namespace creation is now required (is this specific to clusteradm, ArgoCD Agent behavior, or a best practice?)
- Including a migration note if this affects existing users with Applications that currently use
CreateNamespace=true- Clarifying whether the namespace must be created on the managed cluster vs. hub cluster for other modes
📝 Suggested documentation enhancement
Consider adding a note before line 170:
> **Note:** The ArgoCD Agent requires the target namespace to exist on the managed cluster before application deployment. > Unlike standalone ArgoCD, the `CreateNamespace` syncOption is not used in this workflow because [add reason].
|
/lgtm |
openshift-merge-bot
bot
merged commit 4ec68fd
into
open-cluster-management-io:main
3 participants
Summary
docs: Update argocd-agent solution to use clusteradm
Related issue(s)
Refs:
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.